Add Counterparty Group Member

POST /api/v1/Counterparties/groups/members

Description

This endpoint is used to add a member to a counterparty group. It returns a CounterpartyGroupMemberResponse object containing information about the newly added member.

Headers:

• None

ApiKey:

• No API key required

Content-Type:

• text/plain

• application/json

• text/json

Path Parameters:

• version: string, required

Query Parameters:

• None

Request Body:

• An AddGroupMemberRequest object containing information about the member to be added to the group.

URL:

• POST: {{baseUrl API url}}/api/v1/Counterparties/groups/members

Response:

• A CounterpartyGroupMemberResponse object containing information about the newly added member.

Error Codes:

• 400: Bad Request

• 404: Resource not found

• 500: Internal server error

Example:

Request:

POST /api/v1/Counterparties/groups/members
{
  "groupId": "1234567890",
  "counterpartyId": "abc123",
  "role": "Member"
}

Response:

HTTP/1.1 200 OK
{
  "id": "abc123",
  "name": "Business Partner 1",
  "type": "Vendor",
  "groupRole": "Member"
}

Method: POST

/api/v1/Counterparties/groups/members

Headers

Content-Type	Value
Content-Type	application/json
---	---
Accept	text/plain

Body (raw)

{
  "counterpartyId": "<uuid>",
  "counterpartyName": "<string>",
  "counterpartyGroupId": "<uuid>"
}

Response: 200

{
  "succeeded": "<boolean>",
  "message": "<string>",
  "errors": [
    "<string>",
    "<string>"
  ],
  "data": {
    "id": "<uuid>",
    "counterpartyId": "<uuid>",
    "counterpartyName": "<string>",
    "counterpartyGroupId": "<uuid>"
  }
}